<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Resolver xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/azeckoski/reflectutils/beanutils/Resolver.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a>   <em class="comment"> *</em>
<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a>  <em class="comment"> *</em>
<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a>  <em class="comment"> */</em>
<a name="17" href="#17">17</a>  <strong>package</strong> org.azeckoski.reflectutils.beanutils;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em>/**<em>*</em></em>
<a name="20" href="#20">20</a>  <em> * Property Name Expression Resolver.</em>
<a name="21" href="#21">21</a>  <em> * &lt;p></em>
<a name="22" href="#22">22</a>  <em> * Methods such as PropertyUtilsBean's &lt;code>setNestedProperty()&lt;/code> method</em>
<a name="23" href="#23">23</a>  <em> * use a &lt;code>Resolver&lt;/code> to process a &lt;i>property name&lt;/i></em>
<a name="24" href="#24">24</a>  <em> * expression and resolve &lt;i>nested&lt;/i>, &lt;i>indexed&lt;/i> and &lt;i>mapped&lt;/i></em>
<a name="25" href="#25">25</a>  <em> * property names. The following code provides an example usage</em>
<a name="26" href="#26">26</a>  <em> * demonstrating all the methods:</em>
<a name="27" href="#27">27</a>  <em> *</em>
<a name="28" href="#28">28</a>  <em> * &lt;pre></em>
<a name="29" href="#29">29</a>  <em> *      // Iterate through a nested property expression</em>
<a name="30" href="#30">30</a>  <em> *      while (resolver.hasNested(name)) {</em>
<a name="31" href="#31">31</a>  <em> *</em>
<a name="32" href="#32">32</a>  <em> *          // isolate a single property from a nested expresion</em>
<a name="33" href="#33">33</a>  <em> *          String next = resolver.next(name);</em>
<a name="34" href="#34">34</a>  <em> *</em>
<a name="35" href="#35">35</a>  <em> *          // Process...</em>
<a name="36" href="#36">36</a>  <em> *          String property = resolver.getProperty(next);</em>
<a name="37" href="#37">37</a>  <em> *          if (resolver.isIndexed(next)) {</em>
<a name="38" href="#38">38</a>  <em> *</em>
<a name="39" href="#39">39</a>  <em> *              int index = resolver.getIndex(next);</em>
<a name="40" href="#40">40</a>  <em> *              bean = getIndexedProperty(bean, property, index);</em>
<a name="41" href="#41">41</a>  <em> *</em>
<a name="42" href="#42">42</a>  <em> *          } else if (resolver.isMapped(next)) {</em>
<a name="43" href="#43">43</a>  <em> *</em>
<a name="44" href="#44">44</a>  <em> *              String key = resolver.getKey(next);</em>
<a name="45" href="#45">45</a>  <em> *              bean = getMappedProperty(bean, property, key);</em>
<a name="46" href="#46">46</a>  <em> *</em>
<a name="47" href="#47">47</a>  <em> *          } else {</em>
<a name="48" href="#48">48</a>  <em> *</em>
<a name="49" href="#49">49</a>  <em> *              bean = getSimpleProperty(bean, property);</em>
<a name="50" href="#50">50</a>  <em> *</em>
<a name="51" href="#51">51</a>  <em> *          }</em>
<a name="52" href="#52">52</a>  <em> *</em>
<a name="53" href="#53">53</a>  <em> *          // remove the processed property from the expression</em>
<a name="54" href="#54">54</a>  <em> *          name = resolver.remove(name);</em>
<a name="55" href="#55">55</a>  <em> *      }</em>
<a name="56" href="#56">56</a>  <em> * &lt;/pre></em>
<a name="57" href="#57">57</a>  <em> *</em>
<a name="58" href="#58">58</a>  <em> * In order to create an implementation, it is important to understand how</em>
<a name="59" href="#59">59</a>  <em> * BeanUtils/PropertyUtils uses the &lt;code>resolver&lt;/code>. The following are</em>
<a name="60" href="#60">60</a>  <em> * the main methods that use it:</em>
<a name="61" href="#61">61</a>  <em> * &lt;ul></em>
<a name="62" href="#62">62</a>  <em> *   &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean}&lt;/li></em>
<a name="63" href="#63">63</a>  <em> *   &lt;ul></em>
<a name="64" href="#64">64</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#getIndexedProperty(Object, String)}&lt;/li></em>
<a name="65" href="#65">65</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#getMappedProperty(Object, String)}&lt;/li></em>
<a name="66" href="#66">66</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#getNestedProperty(Object, String)}&lt;/li></em>
<a name="67" href="#67">67</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#getPropertyDescriptor(Object, String)}&lt;/li></em>
<a name="68" href="#68">68</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#getSimpleProperty(Object, String)}&lt;/li></em>
<a name="69" href="#69">69</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#setIndexedProperty(Object, String, Object)}&lt;/li></em>
<a name="70" href="#70">70</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#setMappedProperty(Object, String, Object)}&lt;/li></em>
<a name="71" href="#71">71</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#setNestedProperty(Object, String, Object)}&lt;/li></em>
<a name="72" href="#72">72</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.PropertyUtilsBean#setSimpleProperty(Object, String, Object)}&lt;/li></em>
<a name="73" href="#73">73</a>  <em> *   &lt;/ul></em>
<a name="74" href="#74">74</a>  <em> *   &lt;li>{@link org.apache.commons.beanutils.BeanUtilsBean}&lt;/li></em>
<a name="75" href="#75">75</a>  <em> *   &lt;ul></em>
<a name="76" href="#76">76</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.BeanUtilsBean#copyProperty(Object, String, Object)}&lt;/li></em>
<a name="77" href="#77">77</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.BeanUtilsBean#setProperty(Object, String, Object)}&lt;/li></em>
<a name="78" href="#78">78</a>  <em> *   &lt;/ul></em>
<a name="79" href="#79">79</a>  <em> *   &lt;li>{@link org.apache.commons.beanutils.locale.LocaleBeanUtilsBean}&lt;/li></em>
<a name="80" href="#80">80</a>  <em> *   &lt;ul></em>
<a name="81" href="#81">81</a>  <em> *       &lt;li>{@link org.apache.commons.beanutils.locale.LocaleBeanUtilsBean#setProperty(Object,</em>
<a name="82" href="#82">82</a>  <em> *        String, Object, String)}&lt;/li></em>
<a name="83" href="#83">83</a>  <em> *   &lt;/ul></em>
<a name="84" href="#84">84</a>  <em> * &lt;/ul></em>
<a name="85" href="#85">85</a>  <em> *</em>
<a name="86" href="#86">86</a>  <em> * @version $Revision: 10 $ $Date: 2008-10-01 10:56:15 +0000 (Wed, 01 Oct 2008) $</em>
<a name="87" href="#87">87</a>  <em> * @see org.apache.commons.beanutils.PropertyUtilsBean#setResolver(Resolver)</em>
<a name="88" href="#88">88</a>  <em> * @since 1.8.0</em>
<a name="89" href="#89">89</a>  <em> */</em>
<a name="90" href="#90">90</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/azeckoski/reflectutils/beanutils/Resolver.html">Resolver</a> {
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>      <em>/**<em>*</em></em>
<a name="93" href="#93">93</a>  <em>     * Extract the index value from the property expression or -1.</em>
<a name="94" href="#94">94</a>  <em>     *</em>
<a name="95" href="#95">95</a>  <em>     * @param expression The property expression</em>
<a name="96" href="#96">96</a>  <em>     * @return The index value or -1 if the property is not indexed</em>
<a name="97" href="#97">97</a>  <em>     * @throws IllegalArgumentException If the indexed property is illegally</em>
<a name="98" href="#98">98</a>  <em>     * formed or has an invalid (non-numeric) value</em>
<a name="99" href="#99">99</a>  <em>     */</em>
<a name="100" href="#100">100</a>     <strong>int</strong> getIndex(String expression);
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <em>/**<em>*</em></em>
<a name="103" href="#103">103</a> <em>     * Extract the map key from the property expression or &lt;code>null&lt;/code>.</em>
<a name="104" href="#104">104</a> <em>     *</em>
<a name="105" href="#105">105</a> <em>     * @param expression The property expression</em>
<a name="106" href="#106">106</a> <em>     * @return The index value</em>
<a name="107" href="#107">107</a> <em>     * @throws IllegalArgumentException If the mapped property is illegally formed</em>
<a name="108" href="#108">108</a> <em>     */</em>
<a name="109" href="#109">109</a>     String getKey(String expression);
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em>/**<em>*</em></em>
<a name="112" href="#112">112</a> <em>     * Return the property name from the property expression.</em>
<a name="113" href="#113">113</a> <em>     *</em>
<a name="114" href="#114">114</a> <em>     * @param expression The property expression</em>
<a name="115" href="#115">115</a> <em>     * @return The property name</em>
<a name="116" href="#116">116</a> <em>     */</em>
<a name="117" href="#117">117</a>     String getProperty(String expression);
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em>/**<em>*</em></em>
<a name="120" href="#120">120</a> <em>     * Indicates whether or not the expression</em>
<a name="121" href="#121">121</a> <em>     * contains nested property expressions or not.</em>
<a name="122" href="#122">122</a> <em>     *</em>
<a name="123" href="#123">123</a> <em>     * @param expression The property expression</em>
<a name="124" href="#124">124</a> <em>     * @return The next property expression</em>
<a name="125" href="#125">125</a> <em>     */</em>
<a name="126" href="#126">126</a>     <strong>boolean</strong> hasNested(String expression);
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>     <em>/**<em>*</em></em>
<a name="129" href="#129">129</a> <em>     * Indicate whether the expression is for an indexed property or not.</em>
<a name="130" href="#130">130</a> <em>     *</em>
<a name="131" href="#131">131</a> <em>     * @param expression The property expression</em>
<a name="132" href="#132">132</a> <em>     * @return &lt;code>true&lt;/code> if the expresion is indexed,</em>
<a name="133" href="#133">133</a> <em>     *  otherwise &lt;code>false&lt;/code></em>
<a name="134" href="#134">134</a> <em>     */</em>
<a name="135" href="#135">135</a>     <strong>boolean</strong> isIndexed(String expression);
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>     <em>/**<em>*</em></em>
<a name="138" href="#138">138</a> <em>     * Indicate whether the expression is for a mapped property or not.</em>
<a name="139" href="#139">139</a> <em>     *</em>
<a name="140" href="#140">140</a> <em>     * @param expression The property expression</em>
<a name="141" href="#141">141</a> <em>     * @return &lt;code>true&lt;/code> if the expresion is mapped,</em>
<a name="142" href="#142">142</a> <em>     *  otherwise &lt;code>false&lt;/code></em>
<a name="143" href="#143">143</a> <em>     */</em>
<a name="144" href="#144">144</a>     <strong>boolean</strong> isMapped(String expression);
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>     <em>/**<em>*</em></em>
<a name="147" href="#147">147</a> <em>     * Extract the next property expression from the</em>
<a name="148" href="#148">148</a> <em>     * current expression.</em>
<a name="149" href="#149">149</a> <em>     *</em>
<a name="150" href="#150">150</a> <em>     * @param expression The property expression</em>
<a name="151" href="#151">151</a> <em>     * @return The next property expression</em>
<a name="152" href="#152">152</a> <em>     */</em>
<a name="153" href="#153">153</a>     String next(String expression);
<a name="154" href="#154">154</a> 
<a name="155" href="#155">155</a>     <em>/**<em>*</em></em>
<a name="156" href="#156">156</a> <em>     * Remove the last property expresson from the</em>
<a name="157" href="#157">157</a> <em>     * current expression.</em>
<a name="158" href="#158">158</a> <em>     *</em>
<a name="159" href="#159">159</a> <em>     * @param expression The property expression</em>
<a name="160" href="#160">160</a> <em>     * @return The new expression value, with first property</em>
<a name="161" href="#161">161</a> <em>     * expression removed - null if there are no more expressions</em>
<a name="162" href="#162">162</a> <em>     */</em>
<a name="163" href="#163">163</a>     String remove(String expression);
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

